ATSUClearLineControls

OSStatus ATSUClearLineControls (
                     ATSUTextLayout iTextLayout,
                     UniCharArrayOffset iLineStart,
                     ItemCount iTagCount,
                     ATSUAttributeTag iTag[]);

iTextLayout

A reference of type ATSUTextLayout. Pass a reference to a text layout object that contains the line whose attributes you want to remove. You cannot pass NULL for this parameter.

iLineStart

A value of type UniCharArrayOffset. Pass the edge offset in backing store memory that corresponds to the beginning of the line whose text layout attribute values you want to remove.

iTagCount

The number of attributes you want to remove. To remove all previously set text layout attributes, pass the constant kATSUClearAll in this parameter. In this case, the value in the iTag parameter will be ignored.

iTag

An array of values of type ATSUAttributeTag. Each element in the array must contain a valid tag that corresponds to the text layout attribute value you want to remove. See Text Layout Attribute Tag Constants for a description of the Apple-defined text layout attribute tag constants. If you pass a style run attribute tag constant or an ATSUI-reserved tag in this parameter, ATSUClearLayoutControls returns the result code kATSUInvalidAttributeTagErr.

function result

A result code. See Result Codes. You can remove unset attribute values from a line without a function error.

DISCUSSION

The ATSUClearLineControls function removes, for a line of text, those previously set text layout attribute values that are identified by tag constants in the iTag array. It replaces them with the default text layout attribute values described in Table C-2.

If you wish to remove all previously set text layout attribute values from a line in a text layout object, pass kATSUClearAll in the iTagCount parameter. If you wish to remove the previously set text layout attributes for an entire text layout object, call the function ATSUClearLayoutControls.

VERSION NOTES

Available beginning with ATSUI 1.1.